Skip to content

Switch to zensical and add new architecture diagram#2397

Open
joecorall wants to merge 15 commits intomainfrom
architecture-diagram
Open

Switch to zensical and add new architecture diagram#2397
joecorall wants to merge 15 commits intomainfrom
architecture-diagram

Conversation

@joecorall
Copy link
Copy Markdown
Member

@joecorall joecorall commented Mar 26, 2026

Purpose / why

Update the diagram at https://islandora.github.io/documentation/technical-documentation/diagram

The new version can be previewed at https://islandora.github.io/documentation/pr-preview/pr-2397/technical-documentation/diagram/

What changes were made?

  • Since mkdocs-material has abandonded mkdocs, switched mkdocs to instead use zensical
  • Broke up the architecture diagram into different mermaid.js diagrams
    • also added some custom CSS/JS to draw animations on the diagrams
    • also some custom JS to zoom into a mermaid diagram
  • Fixed some other docs in the technical-documentation that were out of date
  • Leveraged zensical's snippets extension. Wrote a bash script to parse our glossary.md into the format the snippets expect, loaded them with the proper config in mkdocs.yml so all our docs can reference terms in the glossary by wrapping the term in []
markdown_extensions:
  - zensical.extensions.preview:
      targets:
        include:
          - user-documentation/glossary.md
  - pymdownx.snippets:
      auto_append:
        - includes/abbreviations.md

Verification

Interested Parties

Checklist

Pull-request Reviewer

Pull-request reviewer should ensure the following:

Person Merging

The person merging should ensure the following:

  • Does mkdocs still build successfully? (This is indicated by TravisCI passing. To test locally, and see warnings, see How To Build Documentation.)
  • If pages are renamed or removed, have all internal links to those pages been fixed?
  • If pages are added, have they been linked to or placed in the menu?
  • Did the PR receive at least one approval from a committer, and all issues raised have been addressed?

@github-actions
Copy link
Copy Markdown

github-actions bot commented Mar 26, 2026

PR Preview Action v1.8.1

QR code for preview link

🚀 View preview at
https://Islandora.github.io/documentation/pr-preview/pr-2397/

Built to branch gh-pages at 2026-03-29 06:37 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

@joecorall joecorall force-pushed the architecture-diagram branch 4 times, most recently from 5a7acd1 to afb5b68 Compare March 26, 2026 14:59
@joecorall joecorall force-pushed the architecture-diagram branch from afb5b68 to 5f28511 Compare March 26, 2026 15:01
And work on diagram animation
@joecorall joecorall force-pushed the architecture-diagram branch from 71ace91 to 6c8694b Compare March 26, 2026 20:18
@joecorall joecorall force-pushed the architecture-diagram branch from 6c8694b to 57c6fc4 Compare March 27, 2026 17:46
@joecorall joecorall force-pushed the architecture-diagram branch from 57c6fc4 to 4ef22c4 Compare March 27, 2026 19:17
@joecorall joecorall force-pushed the architecture-diagram branch from 4ef22c4 to 50be399 Compare March 27, 2026 19:41
@joecorall joecorall marked this pull request as ready for review March 27, 2026 20:56
@joecorall joecorall changed the title Add new architecture diagram Switch to zensical and add new architecture diagram Mar 27, 2026
@aOelschlager
Copy link
Copy Markdown
Contributor

aOelschlager commented Mar 28, 2026

Should NGINX and Traefik be added to the other open source section of the diagram page?

Everything else I read looks good to me. Thanks Joe!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants